﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once

#include "GcmpModelInterface.h"
#include "IElement.h"

namespace gcmp
{
    /// \brief 扣减关系对象
    /// 
    /// 扣减关系，即一个构件与另外一个构件的几何体有重合时，进行布尔减后创建的相互关系。如梁和墙的扣减关系
    FINAL_INTERFACE class GCMP_MODEL_INTERFACE_EXPORT IElementCut : public IElement
    {
        DEFINE_CAST_DERIVED(gcmp::IElementCut, gcmp::IElement);
    public:
        /// \brief 析构函数
        virtual ~IElementCut();   

        /// \brief 创建扣减关系对象
        /// 
        /// 创建IElementCut内部当useGraphicsShapeIntersect的值为true时进行是否扣减判断（CutUtils::IsGraphicsShapeIntersect），不能扣减会返回空指针；useGraphicsShapeIntersect为false时不会做判断，直接进行扣减
        /// 如果被扣减对象是instance，如果不使用打洞Grep进行扣减，则会使用扣减对象的扣减grep进行扣减（扣减对象是instance平台默认是如果有连接就用连接的grep,没有就用baseGrep），用户可以通过派生实现ICutterGraphicsElementShapeComponent，然后设置到几何关系组件中改变默认行为
        /// 如果被扣减对象是instance，如果使用打洞Grep进行扣减（扣减对象是instance，平台默认会使用族中扣减体的grep进行扣减），用户可以通过几何关系组件获取IOpeningGraphicsElementShapeComponent，设置grep改变默认行为
        /// 如果被扣减对象是element，扣减后的grep由用户绑定计算器计算
        /// \param pDocument 当前文档
        /// \param cutterId 扣减对象的ElementId
        /// \param cutteeId 被扣减对象的ElementId
        /// \param useOpeningGraphicsShapeToCut 是否使用打洞Grep进行扣减操作
        /// \param useGraphicsShapeIntersect 是否在扣减操作前进行相交判断
        /// \param isAllowCutEachOther 是否允许相互扣减：为false，则两个构件只存在一种扣减关系，新的扣减关系把原来的冲掉；为true则可以存在两个elementCut，即A扣B，也可以B扣A，都会保留。
        /// \return 扣减关系对象
        static IElementCut* Create(IDocument* pDocument, const ElementId &cutterId, const ElementId &cutteeId, bool useOpeningGraphicsShapeToCut = false, bool useGraphicsShapeIntersect = true, bool isAllowCutEachOther = false);

        /// \brief 获取扣减对象的ElementId
        /// \return 扣减对象的ElementId
        virtual ElementId GetCutterId() const = 0;

        /// \brief 设置扣减对象
        /// \param cutterId 扣减对象的ElementId
        /// \return 无
        virtual void SetCutterId(const ElementId& cutterId) = 0;

        /// \brief 获取被扣减对象的ElementId
        /// \return 被扣减对象的ElementId
        virtual ElementId GetCutteeId() const = 0;

        /// \brief 设置被扣减对象
        /// \param cutteeId 被扣减对象的ElementId
        /// \return 无
        virtual void SetCutteeId(const ElementId& cutteeId) = 0;

        ///\brief 判断是否为扣减对象
        ///\param elementId 对象的ElementId，ElementId必须是扣减对象或者被扣减对象的Id
        ///\return 如果为扣减对象的ElementId则返回true，否则返回false
        ///不建议使用该接口，在必须使用的情况下请先联系平台接口人，确认没有问题再使用
        virtual bool IsCutter(const ElementId& elementId) const = 0;

        /// \brief 获取Implementation Uid
        ///
        /// \return UniIdentity 返回ImplementationUid
        static UniIdentity GetImplementationUid();

        ///\brief 是否使用打洞Grep进行扣减操作
        ///\return 如果使用打洞Grep进行扣减则返回true，否则返回false
        virtual bool IsUseOpeningGraphicsShapeToCut() const = 0;

        /// \brief   获取被扣减对象的关联更新id 
        /// \return  获取被扣减对象的RegenDataId
        virtual RegenDataId GetCutteeIdRdId() const = 0;

        /// \brief 标记CutteeId已发生改变
        virtual void MarkCutteeIdRdId() = 0;

        /// \brief  获取扣减对象的关联更新id 
        /// \return 获取扣减对象的RegenDataId
        virtual RegenDataId GetCutterIdRdId() const = 0;

        /// \brief 标记CutterId已发生改变
        virtual void MarkCutterIdRdId() = 0;
    };
}


